Skip to content
This repository was archived by the owner on Jan 9, 2026. It is now read-only.

Conversation

@allanday
Copy link
Contributor

This is a rough draft for an initial set of content for the user docs. Everything here is open to change. I would like to hear feedback, primarily on the general structure and scope.

Some things to note about this PR:

  • It envisages that the getting started guide in the docs will replace the existing tutorial that's included in the extension.
  • It deliberately doesn't document everything (in order to keep the size of the docs down). Instead, the goal is to provide enough information for people to get started and be able to get effective results from the models.
  • If we go ahead with this, it will make the existing website content somewhat redundant, so we'll need to rework that.

There are a lot of TODOs and FIXMEs in the PR that will need addressing. In particular it needs queries that are known to work well with the existing Granite models.

A build of the static site, so people can preview these changes: granitecode-docs.zip

@allanday allanday force-pushed the first-content branch 2 times, most recently from a844e42 to b60a53f Compare May 28, 2025 15:50
Copy link

@owtaylor owtaylor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally looks like a great start!

Random note: on the visual side, it seems to me that maybe the font is a bit too big which results in short/ragged lines?

@allanday allanday force-pushed the first-content branch 4 times, most recently from 3bf7cd1 to 80ef06b Compare June 17, 2025 15:55
@allanday
Copy link
Contributor Author

I've addressed all the feedback and done another round of polish on the text.

The main outstanding task is the initial examples. @owtaylor I felt that your suggestions were maybe not demonstrative of the broad categories of questions that someone might want to ask. I'd be happy to talk this through.

@allanday allanday changed the title Draft: add initial batch of content Add initial batch of content Jun 18, 2025
@allanday allanday merged commit 0e747ee into main Jun 18, 2025
@allanday
Copy link
Contributor Author

The main outstanding task is the initial examples. @owtaylor I felt that your suggestions were maybe not demonstrative of the broad categories of questions that someone might want to ask. I'd be happy to talk this through.

Reported as #4

@allanday allanday deleted the first-content branch July 3, 2025 10:16
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants